/*
 * Copyright (c) 2010 Curtis Boyden.  All rights reserved. 
 * This software was developed by Curtis Boyden and is provided under the terms 
 * of the GNU Lesser General Public License, Version 2.1. You may not use 
 * this file except in compliance with the license. If you need a copy of the license, 
 * please go to http://www.gnu.org/licenses/lgpl-2.1.txt. The Original Code is ejMud
 * (Ewerp Java MUD).  The Initial Developer is Curtis Boyden.
 *
 * Software distributed under the GNU Lesser Public License is distributed on an "AS IS" 
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or  implied. Please refer to 
 * the license for the specific language governing your rights and limitations.
 */
package com.ewerp.server.commands.engine;

import com.ewerp.server.commands.ICommand;

/**
 * The {@link ICommandEngine} executes {@link ICommand} from a {@link ICommand}
 * queue.
 * 
 * @author cboyden
 * 
 */
public interface ICommandEngine {

    /**
     * Push an {@link ICommand} onto a queue for execution
     * 
     * @param command
     *            The command to add to the execution queue <br />
     *            <ul>
     *            <li>{@link ICommand} : A valid command extending
     *            {@link ICommand}</li>
     *            <li>null : A null value will result in an
     *            {@link IllegalArgumentException}</li>
     *            </ul>
     * @throws IllegalArgumentException
     *             Must be thrown if {@link ICommand} is null
     * @throws FailedToPushCommandException
     *             Thrown if an error occurs pushing the {@link ICommand} into
     *             the queue
     */
    public void pushCommand(ICommand command) throws IllegalArgumentException, FailedToPushCommandException;
}
